home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / bbs_soft / sfpckusr.zip / SFPCKUSR.DOC < prev   
Text File  |  1993-03-06  |  8KB  |  189 lines
  1.                                 SFPCKUSR
  2.                                Version 1.4
  3.                   Copyright (C) by Mike Woltz, 1992-1993
  4.                           Buffalo Creek Software
  5.     
  6.  
  7.     INTRODUCTION
  8.     ------------
  9.  
  10.       SFPCKUSR is a utility written by Mike Woltz, author of SPITFIRE
  11.     Bulletin Board System.  It is designed to work in the same way as 
  12.     SPITFIRE's internal user packer.  However, SFPCKUSR allows the
  13.     caller's data file, SFUSERS.DAT to be packed outside of SPITFIRE.
  14.     Using SFPCKUSR it is even possible to pack the user's file as a
  15.     SPITFIRE event.  SFPCKUSR is written in Turbo Assembler for 
  16.     maximum speed while requiring very little disk space.
  17.  
  18.  
  19.     DISTRIBUTION PACKAGE
  20.     --------------------
  21.       
  22.       When decompressed, the distribution package, SFPCKUSR.ZIP, should
  23.     contain the following files:
  24.     
  25.        SFPCKUSR.DOC    - This documentation file
  26.        SFPCKUSR.EXE    - SPITFIRE utility for packing SFUSERS.DAT
  27.       
  28.       You are free to distribute the SFPCKUSR program as long as it remains
  29.     unmodified and no fee is charged.  Sysops are free to post this and 
  30.     subsequent versions of SFPCKUSR on public Bulletin Board Systems as
  31.     long as no fee is charged to obtain the file.
  32.  
  33.  
  34.     COMMAND LINE PARAMETER
  35.     ----------------------
  36.  
  37.       SFPCKUSR allows for the use of two command line parameters.  The
  38.     command lines parameters are not required for usage.  In the event
  39.     no command line parameter is used, the SFPCKUSR will purge only
  40.     caller who are marked for deletion.  Either one or both command line
  41.     parameters can be used.  These command line parameters are /SEC=x
  42.     and /OLD=x (x indicates a value).  When the /SEC=x parameter is used,
  43.     then SFPCKUSR will pack all callers with a security level of x provided
  44.     such caller is allowed to be purged.  When the /OLD=x parameter is used,
  45.     the SFPCKUSR will pack all callers who have not called in the last x
  46.     days provided such callers are allowed to be purged.  When using the
  47.     /OLD=x parameter, the x value must be a numerical value equal to or
  48.     greater than 30 and less than or equal to 65535.  An example of using
  49.     SFPCKUSR with the command line parameters might be:
  50.     
  51.     SFPCKUSR /OLD=120 /SEC=5
  52.     
  53.     If the caller has not called within the number of days you specify 
  54.     on the command line, the caller will be packed from SFUSERS.DAT.  In
  55.     the example above, any callers who have not called the BBS within
  56.     the last 120 days would be purged from SPITFIRE's caller data file.
  57.     Additionally, the above example provides that callers with a security
  58.     level of 5 would be purged from SFUSERS.DAT provided such purge is
  59.     allowed.
  60.  
  61.        In the event no command line parameter is included on the command
  62.     line, SFPCKUSR will pack only those callers who have been marked for
  63.     deletion.
  64.  
  65.  
  66.     USAGE
  67.     -----
  68.     
  69.        SFPCKUSR must be executed from the SPITFIRE home directory.  This
  70.     is the directory in which SFNODE.DAT resides.  If SFPCKUSR does not
  71.     find SFNODE.DAT operation will be halted, and a message will be
  72.     displayed notifying you that SFNODE.DAT could not be found.
  73.     
  74.        SFPCKUSR will next read SFWHOSON.DAT in the SPITFIRE work directory.
  75.     SFPCKUSR will not allow you to pack the callers file while a caller is
  76.     on any of the available nodes.  If a caller is on any of the available
  77.     nodes, SFPCKUSR will loop until all nodes are free.  Once all the
  78.     available nodes are free, SFPCKUSR will then begin the process of
  79.     packing the SPITFIRE's callers data file, SFUSERS.DAT.  If a caller
  80.     attempts to log on while SFPCKUSR is in the process of packing the
  81.     callers file, SFPCKUSR will notify the caller that system maintenance
  82.     is being performed.  SFPCKUSR will display a message asking the caller
  83.     to call back at a later time and then log the caller off.  SFPCKUSR
  84.     will display SPITFIRE's SFMAINT.BBS/CLR if found.
  85.     
  86.        SFPCKUSR will either create or append to the existing SFPURGED.USR
  87.     data file a list of all callers who have been purged during its
  88.     execution.  SFPURGED.USR contains the date and time of the purge
  89.     activity, the caller's name, the security level of the caller and
  90.     the city/state/province of the caller.
  91.     
  92.        SFPCKUSR does NOT create any backup files.  
  93.  
  94.     
  95.     USING SFPCKUSR AS A SPITFIRE EVENT
  96.     ----------------------------------
  97.     
  98.        SFPCKUSR can be used as a command from the DOS prompt or be
  99.     executed as a SPITFIRE event.  To set SFPCKUSR up as an event
  100.     you simply need to follow the instructions in the SPITFIRE manual
  101.     for setting up an event.  Below is an example of how the SF.BAT 
  102.     might look like when executing SFPCKUSR as an event:
  103.     
  104.     :EVENT_A
  105.        SFPCKUSR /OLD=x
  106.        GOTO LOOP
  107.     :EVENT_B
  108.     
  109.     Above, x represents the numerical value for specifying the number 
  110.     of days a caller must have called within to be exempt from the purge 
  111.     process.  This is an optional command line parameter and if not used, 
  112.     SFPCKUSR will purge only callers which have been marked for deletion.
  113.     
  114.         
  115.     SFPCKUSR ON A MULTI-NODE SYSTEM
  116.    -------------------------------
  117.  
  118.        SFPCKUSR is fully compatible for operation on a multi-node BBS.
  119.     It automatically handles any file locking and file sharing 
  120.     required during its execution.   
  121.     
  122.     
  123.     COPYRIGHT INFORMATION
  124.     ---------------------
  125.  
  126.     SPITFIRE is Copyright of Buffalo Creek Software, 1987-1992
  127.  
  128.  
  129.     REGISTRATION
  130.     ------------
  131.  
  132.        SFPCKUSR is distributed under the shareware concept.  You may use
  133.     the files included within SFPCKUSR.ZIP for a trial period of thirty
  134.     days.  If you continue to use these programs beyond the thirty day
  135.     trial period a $1.00 registration fee is required.  Registration 
  136.     should be sent to:
  137.  
  138.                          Buffalo Creek Software
  139.                          ATTN: Mike Woltz
  140.                          913 39th Street
  141.                          West Des Moines, Iowa   50265
  142.  
  143.  
  144.     DISCLAIMER
  145.     ----------
  146.         
  147.        Mike Woltz and/or Buffalo Creek Software shall in no way be 
  148.     held responsible for any damage incurred while operating SFPCKUSR.
  149.     All responsibility lies with the user of the software.
  150.  
  151.        The documentation for SFPCKUSR is contributed by Jacque
  152.     Shipley and The Mother Board BBS.  The shareware version of
  153.     SPITFIRE and other SPITFIRE utilities are available for download
  154.     from:
  155.  
  156.          Buffalo Creek's BBS              The Mother Board BBS
  157.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  158.            (515) 225-8496                    (515) 986-3464
  159.     38400/19200/9600/2400/1200 Baud      19200/9600/2400/1200 Baud
  160.  
  161.     SFPCKUSR Version 1.1 - August 15, 1992
  162.     --------------------------------------
  163.         SFPCKUSR was revised to test for adequate disk space before
  164.     starting the pack.  In the event there is inadequate disk space
  165.     to perform the pack, then SFPCKUSR displays the 'Insufficient
  166.     disk space!' message and terminates.
  167.  
  168.     SFPCKUSR Version 1.2 - January 1, 1993
  169.     --------------------------------------
  170.         SFPCKUSR was revised to fix a problem with the number of days
  171.     since the caller last called.  The example of the problem is if
  172.     SFPCKUSR was ran on 01-01-93 it would purge any caller who had called
  173.     on 12-31-92.
  174.  
  175.     SFPCKUSR Version 1.3 - March 3, 1993
  176.     --------------------------------------
  177.         SFPCKUSR was revised to work in conjunction with SPITFIRE v3.3.
  178.     The internal caller database pack procedure was removed from SPITFIRE
  179.     and SPITFIRE (v3.3) now shells to SFPCKUSR.  Therefore, SFPCKUSR.COM
  180.     must be placed in the SPITFIRE HOME directory.
  181.  
  182.     SFPCKUSR Version 1.4 - March 6, 1993
  183.     --------------------------------------
  184.         SFPCKUSR was revised to fix a small problem.  The problem could exist
  185.     when SFPCKUSR was used from the SPITFIRE Sysop Menu on a node other than
  186.     node #1 and when the person who packed the caller database immediately
  187.     logged back on after logging off.  Chances of this happening are EXTREMELY
  188.     rare, however, the problem was fixed.
  189.